home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / lfc20.zip / LFC.DOC < prev    next >
Text File  |  1992-03-14  |  22KB  |  502 lines
  1.  
  2.                        Last Few Callers (LFC) v2.0
  3.  
  4.                        Copyright 1992 Ernie Johnson
  5.                             All Rights Reserved
  6.  
  7.  
  8.     About LFC
  9.     ----------------------------------------------------------------------
  10.     LFC is my answer to a bulletin creator to report the "last few
  11.     callers" on my BBS.  I've looked over many bulletin generators of
  12.     this type, but never found one I really liked - one of them came
  13.     close, and I ended up registering it.
  14.  
  15.     As time went on, I found the desire for a better caller generator,
  16.     one with the features that I wanted, and so I ended up writing my
  17.     own callers bulletin generator based on one that one of my users was
  18.     making an attempt to write.
  19.  
  20.  
  21.     LFC Features
  22.     ----------------------------------------------------------------------
  23.     You are probably wondering what makes LFC different from the other
  24.     last caller bulletin generators on the market.  Here is a list of
  25.     features in version 2.0:
  26.  
  27.     - Sysop customizable bulletin "header"
  28.  
  29.     - Sysop customizable bulletin "footer" (registered version only)
  30.  
  31.     - Sysop customizable colors using PCBoard @-codes
  32.  
  33.     - Sysop customizable number of entries to keep in the bulletin
  34.  
  35.     - Works after the user logs off - don't tie the user up any longer
  36.       than necessary during logins
  37.  
  38.     - LFC generates a new bulletin even if the user logs off from in a door
  39.  
  40.     - Includes a field in the bulletin showing how long a user was online.
  41.       Great for finding out who "hogs" the system time!
  42.  
  43.     - Is up to date - why have a "who called yesterday" bulletin, when you
  44.       can keep track of the last person on the system today?
  45.  
  46.     - Low registration cost - why pay more for less?
  47.  
  48.  
  49.     Shareware
  50.     ----------------------------------------------------------------------
  51.     LFC - Last Few Callers - is Copyrighted, Shareware software.  It is
  52.     not free to use, but rather an evaluation copy of the program which
  53.     you are free to use for a trial period not to exceed thirty (30)
  54.     days, after which you must discontinue use of LFC, or send in a
  55.     modest registration fee.
  56.  
  57.     When you register LFC, you will be allowed to define your own
  58.     bulletin "footer" message and the "unregistered" line will be
  59.     removed from the bulletin.
  60.  
  61.  
  62.     How to Register LFC
  63.     ----------------------------------------------------------------------
  64.     You may register LFC with one of three different registration
  65.     options outlined below:
  66.  
  67.     1)  Basic, least expensive registration:    $ 7.00
  68.         This gets you a letter of appreciation with the necessary
  69.         information on how to add your registration "key" file to LFC so
  70.         it knows you are a registered user.
  71.  
  72.     2)  Program upgrade/key file inclusion:     $ 10.00
  73.         This gets you the latest version of LFC on disk along with the
  74.         necessary "key" file so LFC knows you have registered the
  75.         program.  If there hasn't been a program update, you will get
  76.         the current version and when a new version/update becomes
  77.         available you will receive it on disk mailed to you.
  78.  
  79.     3)  Unlimited program updates:              $ 15.00
  80.         This gets you the same options as registration option 2, BUT you
  81.         will receive all major updates to LFC as they are released on
  82.         disk, mailed directly to you.
  83.  
  84.     Please make your check or money order payable to Ernie Johnson
  85.     and mail to:
  86.  
  87.     Ernie Johnson
  88.     EPIC Information Systems
  89.     P.O. Box 607
  90.     Wingham, Ontario
  91.     N0G 2W0 - Canada
  92.  
  93.     If you have any questions, please write to us at the above address,
  94.     or call our support BBS.  Our BBS numbers are:
  95.  
  96.     (519) 357-1943 1200->  2400 baud, v.42 ATI 2400etc
  97.     (519) 357-2952 1200->38,400 baud US Robotics Dual Standard HST
  98.  
  99.     On receipt of payment, your registration information will be sent,
  100.     and the latest version of LFC on diskette (optional).
  101.  
  102.     To make things easier for registering, simply print out the
  103.     ORDER.FRM file in the archive, complete it, attach a check or money
  104.     order and mail to to the above address!
  105.  
  106.  
  107.     Order form as found in ORDER.FRM file
  108.     ----------------------------------------------------------------------
  109.  
  110.                         Last Few Callers v2.0 Order Form
  111.        
  112.        NAME:       ____________________________________________________
  113.        
  114.        COMPANY:    ____________________________________________________
  115.        
  116.        ADDRESS:    ____________________________________________________
  117.        
  118.                    ____________________________________________________
  119.        
  120.        CITY:       ________________________
  121.        
  122.        STATE/PROV: __________________ ZIP/POSTAL CODE: ________________
  123.        
  124.        PHONE:      ____________________________________________________
  125.        
  126.        WHERE DID YOU RECEIVE LFC?  ____________________________________
  127.        
  128.        COMMENTS:   ____________________________________________________
  129.        
  130.        ________________________________________________________________
  131.        
  132.        Item                                                      Price
  133.        ----------------------------------------------------------------
  134.         LFC  v2.0  Unlimited Updates........................... $15.00
  135.            Unlimited program updates mailed to you along
  136.            with your registration information!
  137.  
  138.         LFC  v2.0  Latest Version.............................. $10.00
  139.            We will mail the latest version of LFC and your
  140.            registration information to you.
  141.  
  142.         LFC  v2.0  Download Registration......................  $ 7.00
  143.            We will mail the registration information for
  144.            LFC to you.  Latest versions of LFC will be
  145.            available on our support BBS.
  146.        
  147.                                                   Total Amount
  148.                                                       Enclosed  _______
  149.        
  150.        Specify disk format  [ ] 5.25, 360K  or [ ] 3.5, 720K
  151.        
  152.                 Mail checks/money orders/inquiries to:
  153.        
  154.                 Ernie Johnson          or phone (519) 357-1941 voice, or
  155.                 P.O. Box 607                    (519) 357-1943 BBS
  156.                 Wingham Ontario                 for more information.
  157.                 N0G 2W0  --  Canada
  158.  
  159.  
  160.  
  161.     Setting Up LFC
  162.     ----------------------------------------------------------------------
  163.     LFC absolutely requires PCBoard version 14.5a.  It will not work on
  164.     PCBoard 14.5 or other earlier versions.  LFC may, however, work on
  165.     other BBS software packages.  These have not been tested and you are
  166.     proceeding at your own risk if you attempt to use LFC on
  167.     non-PCBoard 14.5a BBS software!
  168.  
  169.     Included in the LFC distribution archive are sample $$LOGON.BAT and
  170.     $$LOGOFF.BAT files.
  171.  
  172.     Here are break downs of each file, explaining what they do:
  173.  
  174.     $$LOGON.BAT
  175.     -----------
  176.     J:\LFC\LFC LOGON 3 J:\LFC\LFC.CFG
  177.  
  178.  
  179.     J:\LFC\LFC     - runs LFC from my J: drive, in the LFC directory.
  180.     LOGON          - indicates BBS logon mode
  181.     3              - node number
  182.     J:\LFC\LFC.CFG - drive, path & name of configuration file
  183.  
  184.  
  185.     You do not need to use the above format for running the LFC program
  186.     with the exception of the command line.  The following is valid and
  187.     will work correctly:
  188.  
  189.     J:
  190.     cd\LFC
  191.     LFC LOGON 3 J:\LFC\LFC.CFG
  192.  
  193.     Note the command line arguments are position specific, meaning that
  194.     you must enter them in the order shown.
  195.  
  196.     Argument 1 is the mode of operation, either LOGON or LOGOFF
  197.     Argument 2 is the node number
  198.     Argument 3 is the drive, path & name of your configuration file
  199.  
  200.  
  201.     $$LOGOFF.BAT
  202.     ------------
  203.     J:\LFC\LFC LOGOFF 3 J:\LFC\LFC.CFG
  204.  
  205.     This is very similar to the $$LOGON.BAT file, with the exception of
  206.     the mode argument.  When the user logs off, LFC needs to know this.
  207.  
  208.     The secret to getting LFC to handle time used online AND work when a
  209.     user logs off from within a door is based on running LFC twice -
  210.     once when a user logs in, and again when the user logs off the
  211.     system.
  212.  
  213.     The next step should be to add the bulletin entry to your PCBoard
  214.     BLT.LST file.  Start up PCBSETUP and select the Main board
  215.     configuration.  Next, edit the bulletin list file to include the
  216.     drive, path and name of the file you set in your configuration file
  217.     (below).
  218.  
  219.     If you were to use the sample, you would add a new bulletin and for
  220.     a drive, path and name use:  J:\LFC\CALLS
  221.     Detailed instructions for editing the BLT.LST file can be found in
  222.     the PCBoard manual.
  223.  
  224.  
  225.     LFC Configuration file (LFC.CFG)
  226.     ----------------------------------------------------------------------
  227.     Most options in the configuration file will be adequate for most
  228.     sysops, but the file drive, path & filename information will not
  229.     likely match your setup.  Here is a listing of a sample
  230.     configuration file (LFC.CFG) and a line by line breakdown of what
  231.     they are used for and what they can be changed to:
  232.  
  233.     C:\PCB\PCBOARD.SYS
  234.     J:\PCB\MAIN\USERS
  235.     J:\LFC\CALLS
  236.     0
  237.     100
  238.     @X0A
  239.     @X0E
  240.     @X0F
  241.     @X0C
  242.     @X0B
  243.     @X09
  244.     @X0D
  245.     ----------------------------------------------------------------------
  246.     Line  1:  drive, path & name of pcboard.sys
  247.     Line  2:  drive, path & name of users file
  248.     Line  3:  drive, path & name of bulletin file
  249.     Line  4:  0=all calls, 1=no local, 2=no sysop, 3=no local/sysop
  250.     Line  5:  # of callers to keep in the bulletin file
  251.     Line  6:  PCBoard color of callers name
  252.     Line  7:  PCBoard color of callers city
  253.     Line  8:  PCBoard color of baud rate
  254.     Line  9:  PCBoard color of date
  255.     Line 10:  PCBoard color of start time
  256.     Line 11:  PCBoard color of minutes used
  257.     Line 12:  PCBoard color of node number
  258.  
  259.  
  260.     If your system has PCBOARD.SYS files in different locations for some
  261.     or all nodes, you will need to create configuration files for each
  262.     node.  Using different configuration files for each node, you can
  263.     also create different "color" combinations for the lines used on
  264.     each node.  One of my beta test sites changes the color of the node
  265.     number for node 1 and node 2 - a great idea!  To keep it simple,
  266.     name each configuration file as LFC1.CFG LFC2.CFG (etc) the number
  267.     representing the BBS node number.
  268.  
  269.     Even though LFC has been written to handle disk access as fast as
  270.     possible, while providing maximum file sharing support, it does take
  271.     time to re-create the bulletin file.  On fast hard disk systems it
  272.     may take a second or less, others might find it takes several
  273.     seconds.  LFC has been tested with 100 last callers in the bulletin
  274.     file on a hard disk with 16ms access time on a 386-16SX computer -
  275.     the bulletin create time is under a second in most cases.  Some
  276.     sysops may opt for less, some more - since the user has logged off
  277.     the system when LFC does its work the time involved in creating long
  278.     bulletins should not be of much concern to most sysops.
  279.  
  280.  
  281.     LFC Customization
  282.     ----------------------------------------------------------------------
  283.     LFC is almost entirely sysop customizable.  The LFC archive should
  284.     have all the files needed to run LFC, with adequate defaults already
  285.     set up.
  286.  
  287.     Here are the files that should be in the archive, and what they do:
  288.  
  289.        LFC.EXE ->  The executable program
  290.        LFC.DOC ->  This file (documentation)
  291.        LFC.CFG ->  LFC Configuration/color information
  292.        LFC.KEY ->  .KEY file for registration information
  293.        LFC.HED ->  Header file for the bulletin
  294.        LFC.TAL ->  Footer/Tail file for the bulletin
  295.    $$LOGON.BAT ->  Sample logon batch file for PCBoard 14.5a
  296.   $$LOGOFF.BAT ->  Sample logoff batch file for PCBoard 14.5a
  297.    FILE_ID.DIZ ->  PCBoard style file description
  298.       DESC.SDI ->  Same as FILE_ID.DIZ
  299.      ORDER.FRM ->  Order form for LFC
  300.     SOURCE.DOC ->  How to reach the author of LFC
  301.  
  302.  
  303.     The LFC.KEY file is necessary to prevent an error message from
  304.     appearing even on unregistered versions of LFC - so don't delete it.
  305.     If you have registered LFC, simply copy your new KEY file over top
  306.     of this one.
  307.  
  308.     The LFC.CFG file is the configuration file - see the section above
  309.     on the configuration file - LFC.CFG
  310.  
  311.     The LFC.HED file is a header, which is the start of the last few
  312.     callers bulletin.  It can be modified as you wish, but it is
  313.     currently set up with the proper character spacing.  You will likely
  314.     only ever need to change the colors.  Note that the colors need to
  315.     be in PCBoard @-code formation - DO NOT use ANSI codes as your
  316.     bulletin will be in ANSI only!  You will find the necessary @ code
  317.     color chart in the back of the PCBoard manual.
  318.  
  319.     The LFC.TAL file is a "footer" and is only available to registered
  320.     users of LFC.  The default file contains a brief message stating the
  321.     program name, and copyright information.  Unregistered users will
  322.     have a message stating that LFC is currently unregistered and for
  323.     evaluation purposes only.  Note that the colors need to be in
  324.     PCBoard @-code formation - DO NOT use ANSI codes as your bulletin
  325.     will be in ANSI only!
  326.  
  327.  
  328.     Temporary Files
  329.     ----------------------------------------------------------------------
  330.     LFC creates several temporary during the time its used, and during
  331.     the time a user is logged into your BBS.
  332.  
  333.     The 2 types of temporary files are:
  334.  
  335.     1) The bulletin temporary file - after a user logs off, the
  336.     temporary bulletin file is put together - basically it is exactly
  337.     like the existing bulletin, with the new user added to it.  LFC then
  338.     deletes the existing bulletin, and renames this temporary file to
  339.     the bulletin file.  It is very rare where the BLT.TMP file exists on
  340.     your machine unless LFC is processing on a node, or in the
  341.     background.  Do not delete this file, LFC will handle it on its own.
  342.  
  343.     2) x.$$$ - the 'x' is a node number 1 to your maximum number of
  344.     nodes.  This file contains information about the caller that is
  345.     extracted from the PCBOARD.SYS file when he/she logs in to your BBS.
  346.     It is extracted and stored first because some doors remove the
  347.     callers information from the PCBOARD.SYS file if a user logs off
  348.     from within a door.  These files are never deleted, but over written
  349.     when LFC operates.
  350.  
  351.     Do NOT delete any of these files when a user is logged into your
  352.     BBS.  You may delete the x.$$$ files if nobody is logged into your
  353.     BBS, but it is not necessary as LFC overwrites them when it needs
  354.     to.
  355.  
  356.  
  357.     Multi node usage
  358.     ----------------------------------------------------------------------
  359.     LFC has built in multi-node/sharing violation support.  You don't
  360.     need to set anything special up to prevent LFC from being run on 2
  361.     nodes at the same time.
  362.  
  363.     If LFC is in use on two nodes at the same time, the node that last
  364.     started LFC will go into a waiting mode for the file sharing locks
  365.     to be released on the files LFC requires.  If the file sharing locks
  366.     are not released in a certain time period (about 20 seconds) the
  367.     program (LFC) will abort and not update.  Note that it is possible
  368.     for this to happen, but I have yet to see it happen unless something
  369.     seriously happens, or a user is online viewing a lengthy last few
  370.     callers bulletin.
  371.  
  372.     LFC has been extensively tested on a three node PCBoard system and I
  373.     have yet to have it fail.  I am not guaranteeing that it will never
  374.     stop (and hang your system) with a file sharing error, but simply
  375.     stating that I have had it running on my BBS and on a beta test BBS
  376.     with no problems for several weeks.  (This was a major concern as
  377.     the callers bulletin generator I previously registered always
  378.     crashed with file sharing errors when two (or more) people logged in
  379.     at the same time - and even though it sounds like a one in a million
  380.     chance, it did happen quite often!)
  381.  
  382.  
  383.     Known "bugs"
  384.     ----------------------------------------------------------------------
  385.     The only known "bug" in LFC is really based on the way PCBoard
  386.     handles its files.  If a caller is in the middle of reading a
  387.     bulletin and he/she drops carrier or logs off, the file locking on
  388.     the bulletin file is NOT released until the BBS software resets.
  389.  
  390.     Since this happens after the $$LOGOFF.BAT file has executed, LFC
  391.     will detect a file sharing error when trying to update the bulletin
  392.     file and eventually abort to DOS without updating the last caller.
  393.  
  394.     Unfortunately, because of some of LFC's features, we can't yet get
  395.     around this inconvenience.  It is a very rare occurrence so it is not
  396.     likely to happen - but it can happen and LFC is fully network
  397.     shareable and needs to deal with it just the same.  Future
  398.     version(s) of LFC will most likely address this problem and provide
  399.     a way to work around this inconvenience.
  400.  
  401.  
  402.     Warranty & Guarantee's
  403.     ----------------------------------------------------------------------
  404.     LFC is in no way warranted to be free of defects, bugs, etc.  It
  405.     has, however, gone through extensive testing on my BBS, and I have
  406.     not seen any adverse effects.  I am not responsible for any adverse
  407.     effects it has on your system (just in case).  You should take any
  408.     steps to avoid virus infection and scan the file for viruses before
  409.     using it on your system.
  410.  
  411.     Comments and suggestions for improvement are more than welcome.
  412.     Please send them via one of the methods listed in the "How to
  413.     Register LFC" portion of this document.
  414.  
  415.     I hereby disclaim any and all warranties or guarantees either
  416.     expressed or implied within this documentation.  As with any new
  417.     software, you should be cautious when first using it and make any
  418.     necessary backups or virus scans.  If you receive a version of LFC
  419.     that does not function properly (or at all) please call our support
  420.     BBS and provide us with information as to where you received LFC.
  421.     You may also download an authentic version of LFC directly from our
  422.     support BBS system.
  423.  
  424.  
  425.     The Future of LFC
  426.     ----------------------------------------------------------------------
  427.     There isn't a lot more to add, but here is a list of ideas already
  428.     on the "drawing board".
  429.  
  430.     - omissions user file - create a list of users that you don't want
  431.       listed in the bulletin
  432.  
  433.     - omissions security file - create a list of access levels you don't
  434.       want listed in the bulletin (ie; new users, sysops, co-sysops, etc)
  435.  
  436.     - ANSI/ASCII bulletin support (not just PCBoard @ codes)
  437.  
  438.     - other fields in the bulletin with sysop customizable fields
  439.  
  440.     - faster bulletin generation
  441.  
  442.     - solution to the "known bugs" list
  443.  
  444.     - any other reasonable idea(s) by users of LFC
  445.  
  446.  
  447.     Contacting the author of LFC
  448.     ----------------------------------------------------------------------
  449.  
  450.     Write to:               Phone (voice):      Phone (bbs):
  451.     ---------------------------------------------------------------------
  452.     Ernie Johnson           (519) 357-1941      (519) 357-1943  2400 v.42
  453.     P.O. Box 607            7pm to 10pm EST     (519) 357-2952  38.4 HST
  454.     Wingham, Ontario        (evenings)          24 hours, 7 days/week
  455.     N0G 2W0 -- Canada
  456.  
  457.     OR:
  458.     ---
  459.     On CompuServe, leave a message to Ernest W Johnson  [70751,2567]
  460.  
  461.     On City2City netmail services, leave a message to Ernie Johnson
  462.     in the Shareware conference.
  463.  
  464.     Note that leaving a message on our support BBS is the fastest
  465.     way to obtain support - even faster than a voice phone call in some
  466.     cases!
  467.  
  468.  
  469.     Thanks
  470.     ----------------------------------------------------------------------
  471.     Thanks to my BBS users - even though they may not know it, every one
  472.     that called my BBS helped me in my alpha/beta test stages!
  473.  
  474.     Give EPIC a call at (519) 357-1943 (2400 baud) or
  475.                         (519) 357-2952 (38400 baud USR Dual Standard)
  476.  
  477.     Also thanks to Phil and David at Knightec BBS who provided me with a
  478.     second beta test site.
  479.     Call Knightec BBS at (519) 940-0007 or (519) 940-0008.
  480.  
  481.  
  482.     Program History
  483.     ----------------------------------------------------------------------
  484.     Version 0.01 - program idea, concepts to generate/obtain bulletin
  485.     information
  486.  
  487.     Version 1.00 - read necessary information from PCBoards CALLERx log
  488.     files - this worked well, until users with more than 2 names signed
  489.     up (ie; first middle last) - also figured this would be too much
  490.     more work to allow use on other BBS software
  491.  
  492.     Version 2.00 - changed to reading PCBOARD.SYS and USERS files, added
  493.     file sharing support over the network, improved bulletin generation
  494.     speed, custom color support, sysop/local logging options, etc.
  495.  
  496.  
  497.     End of LFC Documentation
  498.     ----------------------------------------------------------------------
  499.     Thanks for giving LFC a try, and don't forget to send in your
  500.     registration!
  501.  
  502.